Update zaptest.Logger to use t.Helper()#1512
Open
bts-bastion wants to merge 2 commits intouber-go:masterfrom
Open
Update zaptest.Logger to use t.Helper()#1512bts-bastion wants to merge 2 commits intouber-go:masterfrom
bts-bastion wants to merge 2 commits intouber-go:masterfrom
Conversation
This provided more meaningful logging location information.
|
|
prashantv
reviewed
Nov 17, 2025
Comment on lines
+43
to
+46
|
|
||
| // Helper marks the calling function as a test helper function. | ||
| // When printing file and line information, that function will be skipped. | ||
| Helper() |
Collaborator
There was a problem hiding this comment.
we don't add methods to an interface as that's technically a breaking change
Instead, we can try to upcast the TestingT interface to see if it has a helper method, and use it if it exists.
Author
There was a problem hiding this comment.
Thanks - understood. I've updated the PR to avoid the adjustment of the TestingT interface.
Using alternative approach from review comments.
prashantv
reviewed
Nov 19, 2025
| return nil | ||
| } | ||
|
|
||
| func (w TestingWriter) IsHelper() { |
Collaborator
There was a problem hiding this comment.
Couple of issues with this:
- This method doesn't need to be exported
- Calling
tb.Helper()from inside of this method probably won't do anything for the callerWritemethod which I thought was the point. Can you include output verifying that this works as expected before/after this change.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This provided more meaningful logging location information.